/*
 * Copyright © 2018 www.noark.xyz All Rights Reserved.
 * 
 * 感谢您选择Noark框架，希望我们的努力能为您提供一个简单、易用、稳定的服务器端框架 ！
 * 除非符合Noark许可协议，否则不得使用该文件，您可以下载许可协议文件：
 * 
 * 		http://www.noark.xyz/LICENSE
 *
 * 1.未经许可，任何公司及个人不得以任何方式或理由对本框架进行修改、使用和传播;
 * 2.禁止在本项目或任何子项目的基础上发展任何派生版本、修改版本或第三方版本;
 * 3.无论你对源代码做出任何修改和改进，版权都归Noark研发团队所有，我们保留所有权利;
 * 4.凡侵犯Noark版权等知识产权的，必依法追究其法律责任，特此郑重法律声明！
 */
package xyz.noark.network.codec;

import io.netty.buffer.ByteBuf;
import io.netty.handler.codec.ByteToMessageDecoder;
import io.netty.handler.codec.MessageToByteEncoder;
import xyz.noark.core.network.NetworkPacket;
import xyz.noark.core.network.PacketCodec;

/**
 * 基本Netty实现的一个抽象编解码器
 *
 * @since 3.0
 * @author 小流氓(176543888@qq.com)
 */
public abstract class AbstractPacketCodec implements PacketCodec {
	/**
	 * 长度编码器.
	 * <p>
	 * 这个需要独立分离出来，因为WebSocket没有包长的概念.
	 * 
	 * @return 长度编码器
	 */
	public abstract MessageToByteEncoder<?> lengthEncoder();

	/**
	 * 长度解码器
	 * <p>
	 * 这个需要独立分离出来，因为WebSocket没有包长的概念.
	 * 
	 * @return 长度解码器
	 */
	public abstract ByteToMessageDecoder lengthDecoder();

	/**
	 * 将二进制数据转化为网络封包对象.
	 * 
	 * @param byteBuf 二进制数据
	 * @return 网络封包对象
	 */
	public abstract NetworkPacket decodePacket(ByteBuf byteBuf);
}